OMEX Extender Response
🔄📦 OMEX Extender Response for Orders
Once the WebSocket connection is established and authenticated, OMEx streams real-time order updates to the client whenever there is a change in order state.
| Field | Value |
|---|---|
| Name | Online Order Response |
| Description | Real-time order update sent from OMEx |
| Delivery Mechanism | WebSocket (Push-based) |
📩 Request Parameters
| Parameter | Data Type | Description |
|---|---|---|
| MessageType | varchar(10) | ORD_NRML |
| OrderNumber | Int64 | 0 for new order entry; fill for modification/cancellation |
| Exchange | varchar(10) | Exchange for which order is to be placed |
| ScripCode | Int | Scrip Code |
| Symbol | varchar(20) | Exchange provided Security symbol |
| Series | varchar(3) | Exchange provided Security Series |
| InstrumentName | varchar(20) | Instrument name |
| ExpiryDate | varchar(10) | Expiry Date |
| StrikePrice | float | Applicable for options only |
| Option_Type | varchar(2) | Option Type — applicable for options only |
| Buy_Sell | Int | 1 = Buy, 2 = Sell |
| OrderOriginalQty | int | Total quantity of an order |
| PendingQty | Int | Pending quantity |
| TradedQTY | int | Traded Quantity |
| OrderPrice | float | Price in paise at which the order is placed |
| OrderStatus | Int | Order status |
| Reason | varchar(255) | Rejection Reason |
| OrderEntryTime | DateTime | Validity |
| LastModifiedTime | DateTime | Date and Time in 24-hour format (e.g., 15Jun2019 15.25.15) |
| UserRemarks | varchar(10) | User Remarks |
| Misc | varchar(10) | Values: SPO-LMT, SPO-MKT, PO-MKT, PO-LMT |
| MessageSequenceNumber | Int64 | Running Message Sequence Number. For latest order status, always use max sequence number. |
| sThirdpartyUserId | varchar(30) | Third party UserId |
| sThirdpartyProductCode | varchar(30) | Product Code as provided by third party |
| sInitiatorAppToken | varchar(30) | Apptoken assigned to Third party |
| sThirdpartyRecoId | varchar(10) | Token assigned by Third party with basket details |
| sPartnerId | varchar(6) | Partner reference who received the trades |
| UniqueCode | varchar(12) | Order ID |
| UCC | varchar(12) | Client ID |
| DQ | Int | Disclosed Qty |
| DQRemaining | Int | Disclosed Qty Remaining |
| TriggerPrice | int | Trigger Price |
| OrderType | Int | Order Type (see Annexure) |
| Days | Int | Days of GTD |
| ProCli | Int | 1 = Client, 2 = Pro |
| CP_ID | varchar(30) | |
| Product | varchar(2) | Product Type |
| SpreadFlag | int | |
| SpreadPrice | int | |
| AMOOrderID | varchar(30) | |
| GTDOrderStatus | int | |
| LegIndicator | int | Leg Indicator |
| MarketType | int | Market Type |
| OrderValidity | int | Order Validity (see Annexure) |
Example Webscoket message
{
"MessageType": "ORD_NRML",
"OrderNumber": "789",
"Exchange": "3",
"ScripCode": "532755",
"Symbol": "CCCC",
"Series": "A",
"InstrumentName": "",
"ExpiryDate": "",
"StrikePrice": 0,
"Option_Type": "",
"Buy_Sell": "1",
"OrderOriginalQty": 1,
"PendingQty": 1,
"TradedQTY": "0",
"OrderPrice": 49975,
"OrderStatus": 5,
"Reason": "",
"OrderEntryTime": "05-May-2020 20.56.37",
"LastModifiedTime": "05-May-2020 20.56.37",
"UserRemarks": "12345ABC0000000001",
"Misc": "MKT",
"MessageSequenceNumber": "10201250000271410",
"sThirdpartyId": "XXXXXXX",
"sThirdpartyProductCode": "XXXXXXX",
"sInitiatorAppToken": "xxxx-18990f355d4",
"sThirdpartyRecoId": "XXXXXXXXXX",
"sPartnerId": "XXXXXX",
"UniqueCode": "XXXXXXXXXXXX",
"UCC": "XXXXXXXXXXXX",
"DQ": 0,
"DQRemaining": 0,
"TriggerPrice": 0,
"OrderType": 1,
"MarketType": 1,
"OrderValidity": "1",
"Days": "0",
"ProCli": "1",
"CP_ID": "",
"Product": "M",
"LegIndicator": 0,
"SpreadFlag": 0,
"SpreadPrice": 0,
"AMOOrderID": "",
"GTDOrderStatus": 0
}
📏📄 OMEX Extender Response for Trade
This section describes the Online Trade Response message sent by OMEx to connected clients via WebSocket.
Once the WebSocket connection is established and authenticated, OMEx streams real-time trade updates whenever a trade is executed.
🔄 Event Type
| Field | Value |
|---|---|
| Name | Online Trade Response |
| Description | Real-time trade execution update |
| Delivery Mechanism | WebSocket (Push-based) |
📝 Request Parameters
| Parameter | Data Type | Description |
|---|---|---|
| MessageType | varchar(10) | ORD_NRML |
| TradeNumber | Int | Trade No |
| OrderNumber | Int64 | 0 for new order; fill for modification/cancellation |
| Exchange | varchar(10) | Exchange for which order is to be placed |
| ScripCode | Int | Scrip Code |
| Symbol | varchar(20) | Exchange provided Security symbol |
| Series | varchar(3) | Exchange provided Security Series |
| InstrumentName | varchar(20) | Instrument name |
| ExpiryDate | varchar(10) | Expiry Date |
| StrikePrice | float | Strike price in multiples of 100 — applicable for options only |
| Option_Type | varchar(2) | Option Type — applicable for options only |
| Buy_Sell | Int | 1 = Buy, 2 = Sell |
| TradeQty | Int | Traded Quantity |
| TradedPrice | int | Trade price in paisa (e.g., 45065 in multiples of 100) |
| OrderOriginalQty | int | Total Quantity of an Order |
| PendingQty | Int | Pending quantity |
| QuantityTradedToday | int | Total quantity traded today including current trade |
| TradeTime | datetime | 24-hour format (e.g., 15Jun2019 15.25.15) |
| OrderTime | datetime | 24-hour format |
| OrderLastModifiedTime | DateTime | Time when order was confirmed |
| UserRemarks | varchar(10) | User Remarks |
| Misc | varchar(10) | Values: SPO-LMT, SPO-MKT, PO-MKT, PO-LMT |
| MessageSequenceNumber | Int64 | Running Message Sequence Number |
| OrderPrice | int | Order Price in paisa |
| sThirdpartyUserId | varchar(30) | Third party UserId |
| sThirdpartyProductCode | varchar(30) | Product Code as provided by third party |
| sInitiatorAppToken | varchar(30) | Apptoken assigned to Third party |
| sThirdpartyRecoId | varchar(10) | Token assigned by Third party with basket details |
| sPartnerId | varchar(6) | Partner reference who received the trades |
| UniqueCode | varchar(12) | Order ID |
| UCC | varchar(12) | Client ID |
| DQ | Int | Disclosed Qty |
| DQRemaining | Int | Disclosed Qty Remaining |
| OrderType | Int | Order Type |
| Days | Int | Days of GTD |
| ProCli | Int | 1 = Client, 2 = Pro |
| CP_ID | varchar(30) | |
| Product | varchar(2) | Product Type |
| LegIndicator | int | Leg Indicator |
Example WebSocket Message
{
"MessageType": "TRD_MSG",
"TradeNumber": "456",
"OrderNumber": "456",
"Exchange": 1,
"ScripCode": 22,
"Symbol": "ACC",
"Series": "EQ",
"InstrumentName": "",
"ExpiryDate": "",
"StrikePrice": 0,
"Option_Type": "",
"Buy_Sell": "1",
"TradeQty": "10",
"TradedPrice": "10000",
"OrderOriginalQty": 10,
"PendingQty": "0",
"QuantityTradedToday": 10,
"TradeTime": "14-May-2020 13.24.28",
"OrderTime": "14-May-2020 13.24.28",
"OrderLastModifiedTime": "14-May-2020 13.24.28",
"UserRemarks": "12345ABC0000000001",
"Misc": "",
"MessageSequenceNumber": 24,
"OrderPrice": 4456,
"sThirdpartyId": "XXXXXXX",
"sThirdpartyProductCode": "XXXXXXX",
"sInitiatorAppToken": "xxxx-18990f355d4",
"sThirdpartyRecoId": "XXXXXXXXXX",
"sPartnerId": "XXXXXX",
"UniqueCode": "XXXXXXXXXXXX",
"UCC": "XXXXXXXXXXXX",
"DQ": 0,
"DQRemaining": 0,
"OrderType": 1,
"Days": "0",
"ProCli": "1",
"CP_ID": "",
"Product": "M",
"LegIndicator": 0
}